***************************************************************************
***                            #QuizPL TeaM                             ***
***                                                                     ***
***                  Najlepszy kanał quizowy na IRC-u!                  ***
***************************************************************************
***                       https://www.quizpl.net                        ***
***                         kontakt@quizpl.net                          ***
***************************************************************************

Witaj drogi Quizowiczu. Oto instrukcja, dzięki której będziesz mógł/mogła samodzielnie napisać i puścić swoją premierę 
quizową na kanale #QuizPL. :)

Pełny poradnik znajdziesz pod adresem: https://www.quizpl.net/poradnik

############################
### I. Instalacja mIRCa. ###
############################

Jeśli masz już ściągniętego i poprawnie skonfigurowanego mIRCa możesz pominąć ten punkt i po uruchomieniu mIRCa dodać 
do ulubionych kanał #QuizPL oraz wejść na kanał poleceniem /join #QuizPL


Aby zaś ściągnąć mIRCa i móc grać na kanale #QuizPL wykonaj poniższe kroki:

1. Ściągnij plik https://www.quizpl.net/viewforum.php?f=79
2. Rozpakuj powyższy plik do dowolnego katalogu, np. C:\Program Files\
3. Przeczytaj zamieszczony tam plik "-= Przeczytaj mnie =-.txt"
4. Uruchom plik mIRC.exe
5. Kliknij teraz na pierwszą ikonkę pod menu (tą z piorunkiem) lub wpisz na dole "/server polska.irc.pl" (bez 
   cudzysłowu) i wciśnij enter. Jeśli połączyłeś się z serwerem i automatycznie otworzyło się nowe okienko, to jesteś 
   już na kanale #QuizPL i od teraz możesz zdobywać punkciki!


Alternatywnie możesz ściągnąć mIRCa ze strony autora programu https://www.mirc.com/get.html lecz wówczas musisz 
samodzielnie skonfigurować program lub napisać na adres kontakt@quizpl.net by uzyskać naszą pomoc.

###############################
### II. Instalacja skryptu. ###
###############################

Rozpakuj to archiwum i przenieś wszystkie pliki do głównego katalogu mIRCa, np. C:\Program Files\mIRC\ oraz uruchom 
plik mirc.exe

Teraz, by móc korzystać ze skryptu (w dniu puszczania quizu), należy go wgrać do uruchomionego wcześniej mIRCa. 
Uzyskasz to poleceniem:

/load -rs mieszacz.als

W okienku statusu powinien pojawić się podobny do tego napis:

* Loaded script 'C:\...\mieszacz.als'

#############################################
### III. Przygotowanie pliku z pytaniami. ###
#############################################

Ten rodzaj quizu nie polega do końca na wiedzy graczy, a bardziej na spostrzegawczości i myśleniu abstrakcyjnym. 
Zawiera on tylko same wyrazy stanowiące odpowiedź, która w momencie gry zostaje rozsypana na pomieszane literki.

Gdy zdecydujesz się napisać swój quiz i puścić go na kanale - wybierz sobie dziedzinę z jakiej chciałbyś napisać quiz 
(może być także wiedza ogólna).

Plik z pytaniami musi być w odpowiedniej postaci. Format pliku polega na tym, że wyrazy stanowiące odpowiedź są 
umieszczane w kolejno numerowanych (ze spacją po numerze) linijkach zakończonych enterem (nie pomyl się z 
numeracją). Przykład:

1 barbara
2 marta
3 agnieszka
4 joanna
5 weronika
6 jadwiga
7 alicja

Przykładowy quiz znajdziesz w pliku "przyklad.txt", zaznajom się z nim.


Podstawowe zasady układania quizów:

- format pliku musi być poprawny, bo quiz utknie na błędnym pytaniu (unikaj zbędnych spacji i wystrzegaj się pustych 
  linii, błędna numeracja)
- nie używaj w hasłach znaków diakrytycznych (ą, ć, ę, ł, ń, ó, ś, ź, ż)
- hasła nie mogą zawierać błędów ortograficznych
- unikaj długich haseł, najlepiej niech mają góra 1-2 wyrazy

Gdy już utworzysz zestaw ok. 60 haseł (na przykład w windowsowym notatniku, ale nie w Wordzie!), to zapisz je w pliku, 
w głównym katalogu z mIRCem. Pamiętaj jednak by nazwa pliku nie zawierała spacji.

################################
### IV. Puszczenie premiery. ###
################################

Kiedy napiszesz już quiz i ustalisz z operatorami kanału dzień i godzinę premiery - możesz przystąpić do jej 
realizacji w wyznaczonym terminie. Nie zapomnij tylko o wgraniu skryptu (patrz punkt II). ;)

Domyślnie skrypt miesza literki z podziałem na wyrazy. Jeśli chcesz zmienić tryb mieszania, aby sklejał wyrazy w jedną 
zbitkę literek użyj polecenia:

/mktryb

Aby uruchomić quiz otwórz okno kanału #QuizPL i wpisz:

/autom #QuizPL przyklad.txt

gdzie za "przyklad.txt" podajesz nazwę własnego pliku z pytaniami.

W razie potrzeby możesz zwiększyć opóźnienie między poszczególnymi pytaniami (domyślnie jest to 5 sekund) poleceniem: 
/del 10

*** Teraz gracze grają i cieszą się z Twojej premiery. ;) ***

Po zakończeniu premiery trzeba wyświetlić wyniki. Uczynisz to poniższym poleceniem. Pamiętaj jednak by wyświetlić 
pełną punktację obejmującą wszystkich grających (uzyskasz to zwiększając liczbę podawaną za poleceniem - gdy 
"/statt 10" nie pokazało wszystkich, to wpisz np. "/statt 15" itd.):

/statt 10

Na koniec zamykasz quiz poleceniem:

/mkoff


Po zakończeniu i zamknięciu quizu możesz (zalecane), ale nie musisz wyładować skrypt z mIRCa. Dokonasz tego 
poleceniem:

/unload -rs mieszacz.als

Aby puścić kolejną premierkę należy ponownie wgrać skrypt poleceniem /load (patrz punkt II).


Uwaga, nie zapomnij by po zakończeniu premiery przysłać plik z pytaniami, temat quizu wraz z datą puszczenia oraz 
pełne wyniki na adres kanałowy: kontakt@quizpl.net Pytania zostaną wówczas dodane do bazy naszego quizbota i wszyscy 
będą mogli się nimi cieszyć jeszcze przez długie lata ;)

##############################
### V. Polecenia kanałowe. ###
##############################

W trakcie trwania premiery quizowej dla graczy dostępne są specjalne polecenia. Pamiętaj, że z uwagi na specyficzny 
sposób funkcjonowania mIRCa te polecenia nie są dostępne dla puszczającego premierę.

Przypomnienie pytania (i pomieszanie literek): !przyp

Poproszenie o kolejną podpowiedź: !podp

Wyświetlenie aktualnej punktacji: !punkty

#################################
### VI. Informacje dodatkowe. ###
#################################

Skrypt ten jest rozszerzoną wersją standardowego mieszacza o dawanie szansy także nieco wolniej piszącym. Uznaje on 
również drugą najszybszą poprawną odpowiedź innego gracza (w przeciągu sekundy od pierwszej).

###################################
### VII. Informacje o skrypcie. ###
###################################

Wersja: Mieszacz
Autor: snajperx
Rozbudowa: ??? (autoquiz), oyey (drugi najszybszy), wilk (tryby mieszania, !przyp + ponowne mieszanie, zabezpieczenie 
   przed takim samym wyrazem, wyświetlanie czasu bonusowej odpowiedzi, poprawki)


Miłej zabawy życzy,
Ekipa #QuizPL.
